\hypertarget{class_r_t_o_s_1_1event}{\section{R\-T\-O\-S\-:\-:event Class Reference}
\label{class_r_t_o_s_1_1event}\index{R\-T\-O\-S\-::event@{R\-T\-O\-S\-::event}}
}


set of things that can happen, or a thing that has happened  




{\ttfamily \#include $<$p\-R\-T\-O\-S.\-h$>$}

Inheritance diagram for R\-T\-O\-S\-:\-:event\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.255814cm]{class_r_t_o_s_1_1event}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_r_t_o_s_1_1event_af3a6450c08560383db9f34b3d826d126}{void \hyperlink{class_r_t_o_s_1_1event_af3a6450c08560383db9f34b3d826d126}{print} (std\-::ostream \&s) const }\label{class_r_t_o_s_1_1event_af3a6450c08560383db9f34b3d826d126}

\begin{DoxyCompactList}\small\item\em prints an event, for debugging only \end{DoxyCompactList}\item 
\hypertarget{class_r_t_o_s_1_1event_ad8d6bd84ac8374c4ab9f9eb8579face0}{bool \hyperlink{class_r_t_o_s_1_1event_ad8d6bd84ac8374c4ab9f9eb8579face0}{operator==} (const \hyperlink{class_r_t_o_s_1_1event}{event} \&rhs) const }\label{class_r_t_o_s_1_1event_ad8d6bd84ac8374c4ab9f9eb8579face0}

\begin{DoxyCompactList}\small\item\em report wether two events are the same \end{DoxyCompactList}\item 
\hypertarget{class_r_t_o_s_1_1event_a2ecee9deb0913822b19ae609256fa685}{bool \hyperlink{class_r_t_o_s_1_1event_a2ecee9deb0913822b19ae609256fa685}{operator==} (const \hyperlink{class_r_t_o_s_1_1waitable}{waitable} \&rhs) const }\label{class_r_t_o_s_1_1event_a2ecee9deb0913822b19ae609256fa685}

\begin{DoxyCompactList}\small\item\em report whether an event corresponds to a waitable \end{DoxyCompactList}\item 
\hypertarget{class_r_t_o_s_1_1event_a7d5e26e1dcd4f4d43cc569188ae4ed12}{bool \hyperlink{class_r_t_o_s_1_1event_a7d5e26e1dcd4f4d43cc569188ae4ed12}{operator!=} (const \hyperlink{class_r_t_o_s_1_1event}{event} \&rhs) const }\label{class_r_t_o_s_1_1event_a7d5e26e1dcd4f4d43cc569188ae4ed12}

\begin{DoxyCompactList}\small\item\em report wether two events are not the same \end{DoxyCompactList}\item 
\hypertarget{class_r_t_o_s_1_1event_a27d10417a15cbb38daca2e7bd3a6a1eb}{bool \hyperlink{class_r_t_o_s_1_1event_a27d10417a15cbb38daca2e7bd3a6a1eb}{operator!=} (const \hyperlink{class_r_t_o_s_1_1waitable}{waitable} \&rhs) const }\label{class_r_t_o_s_1_1event_a27d10417a15cbb38daca2e7bd3a6a1eb}

\begin{DoxyCompactList}\small\item\em report whether an event does not correspond to a waitable \end{DoxyCompactList}\item 
\hyperlink{class_r_t_o_s_1_1event}{event} \hyperlink{class_r_t_o_s_1_1event_addfcf242018d11a0f35f510d17683697}{operator+} (const \hyperlink{class_r_t_o_s_1_1event}{event} \&rhs) const 
\begin{DoxyCompactList}\small\item\em add two waitables, result can be used in a wait() call \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_r_t_o_s_1_1event_a00cf9d5d01e670e2b358c2a4c7578e7d}{\hyperlink{class_r_t_o_s_1_1event_a00cf9d5d01e670e2b358c2a4c7578e7d}{event} (\hyperlink{class_r_t_o_s_1_1task}{task} $\ast$\hyperlink{class_r_t_o_s_1_1event_a1402687edb26c1d5d26e54dbda21919d}{t}, unsigned int \hyperlink{class_r_t_o_s_1_1event_a74f6161d8c82d461ae3ba29f0e222b59}{mask})}\label{class_r_t_o_s_1_1event_a00cf9d5d01e670e2b358c2a4c7578e7d}

\begin{DoxyCompactList}\small\item\em constructor, used by concrete events \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_r_t_o_s_1_1event_a1402687edb26c1d5d26e54dbda21919d}{\hyperlink{class_r_t_o_s_1_1task}{task} $\ast$ \hyperlink{class_r_t_o_s_1_1event_a1402687edb26c1d5d26e54dbda21919d}{t}}\label{class_r_t_o_s_1_1event_a1402687edb26c1d5d26e54dbda21919d}

\begin{DoxyCompactList}\small\item\em the owner task \end{DoxyCompactList}\item 
unsigned int \hyperlink{class_r_t_o_s_1_1event_a74f6161d8c82d461ae3ba29f0e222b59}{mask}
\begin{DoxyCompactList}\small\item\em the mask of this event, one bit is set \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Friends}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_r_t_o_s_1_1event_a0ee29d8961a0b67cea2c3fa76da116da}{class {\bfseries waitable\-\_\-set}}\label{class_r_t_o_s_1_1event_a0ee29d8961a0b67cea2c3fa76da116da}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
set of things that can happen, or a thing that has happened 

An event
\begin{DoxyItemize}
\item is the result of adding waitables
\item is accepted as argument to wait()
\item is returned by wait()
\item can be compared to a waitable
\end{DoxyItemize}

The \hyperlink{class_r_t_o_s_1_1task_a6fc603d0f1c8a94813586d3dfd123fcc}{task\-::wait()} calls return an event. Such an event can be compared to a waitable. The result is true if and only if the waitable caused the event.

Events are the only \hyperlink{class_r_t_o_s}{R\-T\-O\-S} objects that can be destroyed (without causing an error). 

\subsection{Member Function Documentation}
\hypertarget{class_r_t_o_s_1_1event_addfcf242018d11a0f35f510d17683697}{\index{R\-T\-O\-S\-::event@{R\-T\-O\-S\-::event}!operator+@{operator+}}
\index{operator+@{operator+}!RTOS::event@{R\-T\-O\-S\-::event}}
\subsubsection[{operator+}]{\setlength{\rightskip}{0pt plus 5cm}{\bf R\-T\-O\-S\-::event} R\-T\-O\-S\-::event\-::operator+ (
\begin{DoxyParamCaption}
\item[{const {\bf event} \&}]{rhs}
\end{DoxyParamCaption}
) const}}\label{class_r_t_o_s_1_1event_addfcf242018d11a0f35f510d17683697}


add two waitables, result can be used in a wait() call 

Waitables can be added (operator+) to construct a 'set of waitables' as argument to a \hyperlink{class_r_t_o_s_1_1task_a6fc603d0f1c8a94813586d3dfd123fcc}{task\-::wait()} call. 

\subsection{Member Data Documentation}
\hypertarget{class_r_t_o_s_1_1event_a74f6161d8c82d461ae3ba29f0e222b59}{\index{R\-T\-O\-S\-::event@{R\-T\-O\-S\-::event}!mask@{mask}}
\index{mask@{mask}!RTOS::event@{R\-T\-O\-S\-::event}}
\subsubsection[{mask}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int R\-T\-O\-S\-::event\-::mask\hspace{0.3cm}{\ttfamily [protected]}}}\label{class_r_t_o_s_1_1event_a74f6161d8c82d461ae3ba29f0e222b59}


the mask of this event, one bit is set 

The bit that is set is unique among the events owned by a task. 

The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
p\-R\-T\-O\-S.\-h\item 
p\-R\-T\-O\-S.\-cpp\end{DoxyCompactItemize}
